fix(RequestInterface): restore catch all overload #404
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gr2m
reviewed
Jun 27, 2022
| : RequestParameters | ||
| ): R extends keyof Endpoints | ||
| ? Promise<Endpoints[R]["response"]> | ||
| : Promise<OctokitResponse<any>>; |
There was a problem hiding this comment.
This is not a full revert of the changes at https://github.com/octokit/types.ts/pull/399/files, is that on purpose?
There was a problem hiding this comment.
Yes that's on purpose. The first overload fixes routes autocompletion in TS 4.7, but we still need the old one for options autocomplete to work properly.
wolfy1339
added
the
Type: Bug
mx636
approved these changes
Aug 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
#399 fixed routes autocompletion, but request options resolution was broken as a result. TypeScript selected second non generic overload once
{}was provided as theoptionsparameter.This PR restores previous generic version which accepts both known/predefined and dynamic routes (in addition to overload that accepts only known routes), so TS will always try to resolve request options type according to provided route.
Closes octokit/core.js#486
** Maybe it worth opening issue in TypeScript and try to understand why existing solution stopped working since 4.7